home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsITransaction.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.9 KB  |  96 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40. /*
  41.  * The nsITransaction interface.
  42.  * <P>
  43.  * This interface is implemented by an object that needs to
  44.  * execute some behavior that must be tracked by the transaction manager.
  45.  */
  46. [scriptable, uuid(58e330c1-7b48-11d2-98b9-00805f297d89)]
  47. interface nsITransaction : nsISupports
  48. {
  49.   /**
  50.    * Executes the transaction.
  51.    */
  52.   void doTransaction();
  53.  
  54.   /**
  55.    * Restores the state to what it was before the transaction was executed.
  56.    */
  57.   void undoTransaction();
  58.  
  59.   /**
  60.    * Executes the transaction again. Can only be called on a transaction that
  61.    * was previously undone.
  62.    * <P>
  63.    * In most cases, the redoTransaction() method will actually call the
  64.    * doTransaction() method to execute the transaction again.
  65.    */
  66.   void redoTransaction();
  67.  
  68.   /**
  69.    * The transaction's transient state. This attribute is checked by
  70.    * the transaction manager after the transaction's Execute() method is called.
  71.    * If the transient state is false, a reference to the transaction is
  72.    * held by the transaction manager so that the transactions' undoTransaction()
  73.    * and redoTransaction() methods can be called. If the transient state is
  74.    * true, the transaction manager returns immediately after the transaction's
  75.    * doTransaction() method is called, no references to the transaction are
  76.    * maintained. Transient transactions cannot be undone or redone by the
  77.    * transaction manager.
  78.    */
  79.   readonly attribute boolean isTransient;
  80.  
  81.   /**
  82.    * Attempts to merge a transaction into "this" transaction. Both transactions
  83.    * must be in their undo state, doTransaction() methods already called. The
  84.    * transaction manager calls this method to coalesce a new transaction with
  85.    * the transaction on the top of the undo stack.
  86.    * This method returns a boolean value that indicates the merge result.
  87.    * A true value indicates that the transactions were merged successfully,
  88.    * a false value if the merge was not possible or failed. If true,
  89.    * the transaction manager will Release() the new transacton instead of
  90.    * pushing it on the undo stack.
  91.    * @param aTransaction the previously executed transaction to merge.
  92.    */
  93.   boolean merge(in nsITransaction aTransaction);
  94. };
  95.  
  96.